banking-api-doc ( 1.0.0 )

Download OpenAPI specification : Download

default

SignUp

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "required" ,
  • "email": "require, Unique" ,
  • "password": "required, at least 6 characters" ,
  • "role": "[OPTIONAL] - Only for admin users. Valid value is cachier. Default customer "
}

SignIn

header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "email": "required" ,
  • "password": "required"
}

Logout

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses

RefreshToken

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses

CreateAccount

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "type": "required. Valid: [savings, current]" ,
  • "initialDeposit": 10000
}

ChangeAccountStatus

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "accountId": 8 ,
  • "status": "valid values [blocked, pending, approved]"
}

GetMyBalance

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses

GetAccountBalance

Authorizations:
bearerAuth
path Parameters
accountId
required
string
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses

InitiateTransaction

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "transactionType": "Valid Values: [withdrawal, deposit, transfer]" ,
  • "accountId": 2 ,
  • "amount": 5000 ,
  • "toAccountNumber": "[OPTIONAL] if it is tranfer enter the account_number eg CUS.13567 to which you wish to send the money" ,
  • "transferMotive": "[OPTIONAL] if it is tranfer eg For nothing"
}

GetMyTransfers

Authorizations:
bearerAuth
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses

GetAccountTransfers

Authorizations:
bearerAuth
path Parameters
accountId
required
string
header Parameters
X-Authorization
string
Example: JTJ8fR5wkuppNrj6wTFSIU5TJUNS45L6ANDeeWhiWvpj8bxcpV5R3Gk8lHQml9Gl

Responses